<!DOCTYPE html>
<html lang="en">
<head>
  <title>Stack Manager - Vert.x</title>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta content="width=device-width, initial-scale=1.0" name="viewport">
  <meta content="Vert.x is a tool-kit for building reactive applications on the JVM." name="description">
  <link href="http://vertx.io/stylesheets/docs.css" media="screen" rel="stylesheet">
  <link href="http://vertx.io/stylesheets/font-awesome.min.css" media="screen" rel="stylesheet">
  <link href="http://vertx.io/javascripts/styles/rainbow.min.css" media="screen" rel="stylesheet">
  <!-- IE 6-8 support of HTML 5 elements -->
  <!--[if lt IE 9]>
  <script src="http://static.jboss.org/theme/js/libs/html5/pre3.6/html5.min.js"></script>
  <![endif]-->

  <link rel="apple-touch-icon" sizes="57x57" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-57x57.png">
  <link rel="apple-touch-icon" sizes="60x60" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-60x60.png">
  <link rel="apple-touch-icon" sizes="72x72" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-72x72.png">
  <link rel="apple-touch-icon" sizes="76x76" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-76x76.png">
  <link rel="apple-touch-icon" sizes="114x114" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-114x114.png">
  <link rel="apple-touch-icon" sizes="120x120" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-120x120.png">
  <link rel="apple-touch-icon" sizes="144x144" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-144x144.png">
  <link rel="apple-touch-icon" sizes="152x152" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-152x152.png">
  <link rel="apple-touch-icon" sizes="180x180" href="http://vertx.io/assets/favicons/vertx-favicon-7/apple-touch-icon-180x180.png">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/favicon-32x32.png" sizes="32x32">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/android-chrome-192x192.png" sizes="192x192">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/favicon-96x96.png" sizes="96x96">
  <link rel="icon" type="image/png" href="http://vertx.io/assets/favicons/vertx-favicon-7/favicon-16x16.png" sizes="16x16">
  <link rel="manifest" href="http://vertx.io/assets/favicons/vertx-favicon-7/manifest.json">
  <link rel="mask-icon" href="http://vertx.io/assets/favicons/vertx-favicon-7/safari-pinned-tab.svg" color="#5bbad5">
  <meta name="msapplication-TileColor" content="#7d3194">
  <meta name="msapplication-TileImage" content="http://vertx.io/assets/favicons/vertx-favicon-7/mstile-144x144.png">
  <meta name="theme-color" content="#ffffff">

  <link href="http://fonts.googleapis.com/css?family=Ubuntu:400,500,700,400italic" rel="stylesheet" type="text/css">
  <link rel="alternate" type="application/rss+xml" title="RSS"
     href="http://vertx.io/feed.xml">
  <script>
    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
    })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
    ga('create', 'UA-30144458-1', 'auto');
    ga('create', 'UA-71153120-1', 'auto', 'tracker');
    ga('send', 'pageview');
    ga('tracker.send', 'pageview');
  </script>
</head>
<body>

<a href="http://www.reactivemanifesto.org/" id="reactive-manifesto-banner">
  <img style="border: 0; position: fixed; right: 0; top:0; z-index: 9000"
    src="http://d379ifj7s9wntv.cloudfront.net/reactivemanifesto/images/ribbons/we-are-reactive-black-right.png">
</a>

<a id="skippy" class="sr-only sr-only-focusable" href="#content"><div class="container"><span class="skiplink-text">Skip to main content</span></div></a>

<header class="navbar navbar-default navbar-static-top" id="top" role="banner">
  <div class="container">
    <div class="navbar-header">
      <button class="navbar-toggle collapsed" type="button" data-toggle="collapse" data-target="#vertx-navbar-collapse">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <a href="http://vertx.io/" class="navbar-brand"><img alt="Brand" src="http://vertx.io/assets/logo-sm.png"></a>
    </div>
    <nav class="collapse navbar-collapse" id="vertx-navbar-collapse">
      <ul class="nav navbar-nav navbar-right">
        <li><a href="http://vertx.io/download/">Download</a></li>
        <li><a href="http://vertx.io/docs/">Documentation</a></li>
        <li><a href="https://github.com/vert-x3/wiki/wiki">Wiki</a></li>
        <li><a href="http://vertx.io/community/">Community</a></li>
        <li><a href="http://vertx.io/materials/">Materials</a></li>
        <li><a href="http://vertx.io/blog/">Blog</a></li>        
      </ul>
    </nav>
  </div>
</header>



  <div class="page-header" id="content">
    <div class="container">
      <div class="row">
        <div class="col-sm-12">
          <h1>Stack Manager</h1>
          
        </div>
      </div>
    </div>
  </div>




<div id="content">
  <div class="container docs-content">
    <div class="row">
      <div class="col-sm-12 col-md-push-9 col-md-3 hidden-xs hidden-sm">
        <div id="sidebar" data-spy="affix">
          <ul class="sectlevel1">
<li><a href="#_stack_manager">Stack Manager</a>
<ul class="sectlevel2">
<li><a href="#_adding_artifacts">Adding artifacts</a></li>
<li><a href="#_removing_artifacts">Removing artifacts</a></li>
<li><a href="#_launching_the_resolution">Launching the resolution</a></li>
<li><a href="#_exclusions_and_transitives">Exclusions and Transitives</a></li>
<li><a href="#_using_variables">Using variables</a></li>
<li><a href="#_a_note_about_the_json_format">A note about the JSON format</a></li>
</ul>
</li>
</ul>
        </div>
      </div>
      <div class="col-sm-12 col-md-pull-3 col-md-9">
        <div class="toc hidden-md hidden-lg">
          <h2>Table of Contents</h2>
          <ul class="sectlevel1">
<li><a href="#_stack_manager">Stack Manager</a>
<ul class="sectlevel2">
<li><a href="#_adding_artifacts">Adding artifacts</a></li>
<li><a href="#_removing_artifacts">Removing artifacts</a></li>
<li><a href="#_launching_the_resolution">Launching the resolution</a></li>
<li><a href="#_exclusions_and_transitives">Exclusions and Transitives</a></li>
<li><a href="#_using_variables">Using variables</a></li>
<li><a href="#_a_note_about_the_json_format">A note about the JSON format</a></li>
</ul>
</li>
</ul>
        </div>
        <div class="sect1">
<h2 id="_stack_manager">Stack Manager</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The stack manager is a tool to manage your vert.x distribution.</p>
</div>
<div class="paragraph">
<p>It maintains the set of jar files contained in the
<code>lib</code> directory. The stack manager takes as input a YAML file describing the <em>dependencies</em> that should be
included in the stack. Then, during the resolution it resolves new dependencies and delete the files that are not
used anymore.</p>
</div>
<div class="paragraph">
<p>If you have downloaded a vert.x distribution, it comes with a <code>vertx-stack.json</code> in the root directory. This file
contains all the official dependencies you can add. By default it <em>includes</em> only the minimal stack.</p>
</div>
<div class="sect2">
<h3 id="_adding_artifacts">Adding artifacts</h3>
<div class="paragraph">
<p>To add an artifact to your stack, just add the dependency if not there already, and set the <code>included</code> value to
<code>true</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code>{
 "groupId": "io.vertx",
 "artifactId": "vertx-sync",
 "version": "${vertx.version}",
 "included": true
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>The dependency is described using the Maven coordinates. The <code>groupId</code>, <code>artifactId</code> and <code>versions</code> attributes are
mandatory. You can also set the <code>type</code> (<code>jar</code> by default) and <code>classifier</code> (none by default).</p>
</div>
</div>
<div class="sect2">
<h3 id="_removing_artifacts">Removing artifacts</h3>
<div class="paragraph">
<p>To remove an artifact, remove the dependency or set the <code>included</code> attribute to <code>false</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code>{
 "groupId": "io.vertx",
 "artifactId": "vertx-sync",
 "version": "${vertx.version}",
 "included": false
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>During the resolution, all files that are not associated to a dependency (or a transitive dependency) are removed.
That means don&#8217;t add files manually, they are going to be deleted.</p>
</div>
</div>
<div class="sect2">
<h3 id="_launching_the_resolution">Launching the resolution</h3>
<div class="paragraph">
<p>To launch the resolution, launch:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code>./bin/vertx resolve --dir=lib</code></pre>
</div>
</div>
<div class="paragraph">
<p>The <code>resolve</code> command supports a set of options:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>--dir &lt;value&gt;</code> - The directory containing the artifacts composing the stack. Defaults to the <code>./lib</code>
directory</p>
</li>
<li>
<p><code>--fail-on-conflict</code>  - Set whether or not the resolver should fail or conflict or just log a warning. Disabled by default.</p>
</li>
<li>
<p><code>--http-proxy &lt;value&gt;</code> - Set the HTTP proxy address if any.</p>
</li>
<li>
<p><code>--https-proxy &lt;value&gt;</code> - Set the HTTPS proxy address if any.</p>
</li>
<li>
<p><code>--local-repo &lt;value&gt;</code> - Set the path to the local Maven repository. Defaults to <code>~/.m2/repository</code></p>
</li>
<li>
<p><code>--remote-repo &lt;value&gt;</code> -  Set the path to a remote Maven repository. Can be set multiple times</p>
</li>
<li>
<p><code>&lt;vertx-stack.json&gt;</code> - The path to the stack descriptor. Defaults to <code>vertx-stack.json</code>.</p>
</li>
<li>
<p><code>--no-cache</code> -  Disable the resolver cache</p>
</li>
<li>
<p><code>--no-cache-for-snapshots</code> - Disable the caching of snapshot resolution</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>If you have set <code>VERTX_HOME</code> as environment variable (or system variable), it uses: <code>$VERTX_HOME/lib</code> and
<code>$VERTX_HOME/vertx-stack.json</code>.</p>
</div>
</div>
<div class="sect2">
<h3 id="_exclusions_and_transitives">Exclusions and Transitives</h3>
<div class="paragraph">
<p>Each dependency can declare a set of exclusions that won&#8217;t be resolved during the resolution process:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code>{
 "groupId": "org.acme",
 "artifactId": "acme-lib",
 "version": "1.0.0",
 "included": true,
 "exclusions": [{
   "groupId": "org.acme",
   "artifactId": "acme-not-required"
 }]
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>You can also set the <code>transitive</code> attribute to <code>false</code> on a dependency to not resolve the transitive dependencies.
This is useful when using fat jars or shaded artifacts:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code>{
 "groupId": "io.vertx",
 "artifactId": "vertx-web-templ-thymeleaf",
 "version": "${vertx.version}",
 "included": true,
 "classifier": "shaded",
 "transitive": false
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_using_variables">Using variables</h3>
<div class="paragraph">
<p>The stack definition allows you to declare variables:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code>{
"variables": {
  "vertx.version": "3.3.3"
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>Then your dependency can uses this variable using the <code>${}</code> notation.</p>
</div>
<div class="paragraph">
<p>Variables can be set or overridden using system variables. System variables can be set with <code>-D</code></p>
</div>
</div>
<div class="sect2">
<h3 id="_a_note_about_the_json_format">A note about the JSON format</h3>
<div class="paragraph">
<p>The descriptor format supports:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>comments using <code>//</code></p>
</li>
<li>
<p>non quoted keys (such as <code>groupId : "org.acme"</code>)</p>
</li>
<li>
<p>single quotes for values (such as <code>groupId : 'org.acme'</code>)</p>
</li>
</ul>
</div>
</div>
</div>
</div>

        

        
          <div id="footer">
            <div id="footer-text">
              
                Last updated 2016-09-12 08:38:06 CEST
              
              
            </div>
          </div>
        
      </div>
    </div>
  </div>
</div>

<footer>
  <div class="container">
    <div class="row">
      <div class="col-xs-6 col-sm-3 col-md-3 col-lg-2">
        <h2>Vert.x</h2>
        <ul class="list-unstyled">
          <li><a href="http://vertx.io/">Home</a></li>
          <li><a href="http://vertx.io/download/">Download</a></li>
          <li><a href="http://vertx.io/docs/">Documentation</a></li>
          <li><a href="https://github.com/vert-x3/wiki/wiki">Wiki</a></li>
          <li><a href="http://vertx.io/blog/">Blog</a></li>
          <li><a href="http://vertx.io/vertx2/" class="vertx-2-link">Vert.x 2</a></li>
        </ul>
      </div>
      <div class="col-xs-6 col-sm-3 col-md-3 col-lg-2">
        <h2>Community</h2>
        <ul class="list-unstyled">
          <li><a href="http://vertx.io/community/">Help &amp; Contributors</a></li>
          <li><a href="http://vertx.io/materials/">Learning materials</a></li>
          <li><a href="https://groups.google.com/forum/?fromgroups#!forum/vertx">User Group</a></li>
          <li><a href="https://groups.google.com/forum/?fromgroups#!forum/vertx-dev">Developer Group</a></li>
        </ul>
      </div>

      <div class="col-xs-12 col-sm-6 col-lg-offset-2 col-md-6 copyright">
        <p>Vert.x is open source and dual licensed under the <a href="https://www.eclipse.org/org/documents/epl-v10.php">Eclipse Public License 1.0</a> and <a href="https://www.apache.org/licenses/LICENSE-2.0.html">Apache License 2.0</a>.</p>
        <p>This website is licensed under the <a href="http://creativecommons.org/licenses/by-sa/3.0/">CC BY-SA 3.0 License</a>.<br>
        Design by <a href="http://www.michel-kraemer.com">Michel Kr&auml;mer</a>. <a href="http://www.entypo.com">Entypo pictograms</a> by Daniel Bruce.</p>
        <div class="row">
          <div class="col-xs-12 col-lg-offset-1 col-md-5">
            <a href="http://eclipse.org">
            <img class="logo eclipse-logo" src="http://vertx.io/assets/eclipse_logo_grey_small.png" width="204" height="48">
            </a>
          </div>
          <div class="col-xs-12 col-md-offset-2 col-lg-offset-0 col-md-5">
            <a href="http://cloudbees.com">
            <img class="logo cloudbees-logo" src="http://vertx.io/assets/Button-Built-on-CB-1-grey.png" width="180" height="48">
           </a>
          </div>
          <div class="col-xs-12 col-md-offset-2 col-lg-offset-1 col-md-5 jprofiler">
            <a href="http://www.ej-technologies.com/products/jprofiler/overview.html"
            style="text-decoration:none">
            <img class="logo jprofiler-logo" src="http://vertx.io/assets/jprofiler-logo.png" width="48" height="48"><span class="jprofiler-logo">&nbsp; JPROFILER</span>
            </a>
          </div>
        </div>
      </div>
    </div>
  </div>
</footer>

<script src="http://static.jboss.org/theme/js/libs/jquery/jquery-1.9.1.min.js"></script>
<script src="http://vertx.io/javascripts/bootstrap.min.js"></script>
<script src="http://vertx.io/javascripts/highlight.pack.js"></script>
<script>hljs.initHighlightingOnLoad();</script>



<script src="http://vertx.io/javascripts/sidebar.js"></script>


</body>
</html>
